<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: cpp_freertos::Ticks Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacecpp__freertos.html">cpp_freertos</a></li><li class="navelem"><a class="el" href="classcpp__freertos_1_1_ticks.html">Ticks</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classcpp__freertos_1_1_ticks-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">cpp_freertos::Ticks Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ticks_8hpp_source.html">ticks.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad289d001946586e6f392872fec51976f"><td class="memItemLeft" align="right" valign="top">static TickType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_ticks.html#ad289d001946586e6f392872fec51976f">GetTicks</a> ()</td></tr>
<tr class="separator:ad289d001946586e6f392872fec51976f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa025f776de91d8c48601f8ef5dd7fff7"><td class="memItemLeft" align="right" valign="top">static TickType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_ticks.html#aa025f776de91d8c48601f8ef5dd7fff7">GetTicksFromISR</a> ()</td></tr>
<tr class="separator:aa025f776de91d8c48601f8ef5dd7fff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dc8a555d3fc7cb9f244f8abcf52192a"><td class="memItemLeft" align="right" valign="top">static TickType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_ticks.html#a5dc8a555d3fc7cb9f244f8abcf52192a">MsToTicks</a> (TickType_t milliseconds)</td></tr>
<tr class="separator:a5dc8a555d3fc7cb9f244f8abcf52192a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7afe69afdf61a4cb9ce638a38d5f945e"><td class="memItemLeft" align="right" valign="top">static TickType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_ticks.html#a7afe69afdf61a4cb9ce638a38d5f945e">SecondsToTicks</a> (TickType_t seconds)</td></tr>
<tr class="separator:a7afe69afdf61a4cb9ce638a38d5f945e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdde0af1fb5cff55eb46b40fe0dd65c2"><td class="memItemLeft" align="right" valign="top">static TickType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__freertos_1_1_ticks.html#afdde0af1fb5cff55eb46b40fe0dd65c2">TicksToMs</a> (TickType_t ticks)</td></tr>
<tr class="separator:afdde0af1fb5cff55eb46b40fe0dd65c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Class encapsulating FreeRTOS idea of a tick. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad289d001946586e6f392872fec51976f" name="ad289d001946586e6f392872fec51976f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad289d001946586e6f392872fec51976f">&#9670;&#160;</a></span>GetTicks()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TickType_t cpp_freertos::Ticks::GetTicks </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Get the current tick count.</p>
<dl class="section return"><dt>Returns</dt><dd>Current tick count. </dd></dl>

</div>
</div>
<a id="aa025f776de91d8c48601f8ef5dd7fff7" name="aa025f776de91d8c48601f8ef5dd7fff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa025f776de91d8c48601f8ef5dd7fff7">&#9670;&#160;</a></span>GetTicksFromISR()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TickType_t cpp_freertos::Ticks::GetTicksFromISR </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Get the current tick count from ISR context.</p>
<dl class="section return"><dt>Returns</dt><dd>Current tick count. </dd></dl>

</div>
</div>
<a id="a5dc8a555d3fc7cb9f244f8abcf52192a" name="a5dc8a555d3fc7cb9f244f8abcf52192a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dc8a555d3fc7cb9f244f8abcf52192a">&#9670;&#160;</a></span>MsToTicks()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TickType_t cpp_freertos::Ticks::MsToTicks </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>milliseconds</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Convert from ms to ticks.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">milliseconds</td><td>milliseconds to convert. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ticks </dd></dl>

</div>
</div>
<a id="a7afe69afdf61a4cb9ce638a38d5f945e" name="a7afe69afdf61a4cb9ce638a38d5f945e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7afe69afdf61a4cb9ce638a38d5f945e">&#9670;&#160;</a></span>SecondsToTicks()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TickType_t cpp_freertos::Ticks::SecondsToTicks </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>seconds</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Convert from seconds to ticks.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">seconds</td><td>seconds to convert. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ticks </dd></dl>

</div>
</div>
<a id="afdde0af1fb5cff55eb46b40fe0dd65c2" name="afdde0af1fb5cff55eb46b40fe0dd65c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdde0af1fb5cff55eb46b40fe0dd65c2">&#9670;&#160;</a></span>TicksToMs()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static TickType_t cpp_freertos::Ticks::TicksToMs </td>
          <td>(</td>
          <td class="paramtype">TickType_t&#160;</td>
          <td class="paramname"><em>ticks</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p >Convert from ticks to ms.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ticks</td><td>ticks to convert. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>milliseconds. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="ticks_8hpp_source.html">ticks.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
